<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/pico/sha256.h File Reference</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.0.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('rp2__common_2pico__sha256_2include_2pico_2sha256_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">sha256.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="common_2pico__time_2include_2pico_2time_8h_source.html">pico/time.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="rp2__common_2hardware__dma_2include_2hardware_2dma_8h_source.html">hardware/dma.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="rp2__common_2hardware__sha256_2include_2hardware_2sha256_8h_source.html">hardware/sha256.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for sha256.h:</div>
<div class="dyncontent">
<div class="center"><img src="rp2__common_2pico__sha256_2include_2pico_2sha256_8h__incl.png" border="0" usemap="#ainclude_2pico_2sha256_8h" alt=""/></div>
<map name="ainclude_2pico_2sha256_8h" id="ainclude_2pico_2sha256_8h">
<area shape="rect" title=" " alt="" coords="500,5,663,32"/>
<area shape="rect" href="common_2pico__time_2include_2pico_2time_8h.html" title=" " alt="" coords="449,155,543,181"/>
<area shape="rect" href="rp2__common_2hardware__dma_2include_2hardware_2dma_8h.html" title=" " alt="" coords="481,229,609,256"/>
<area shape="rect" href="rp2__common_2hardware__sha256_2include_2hardware_2sha256_8h.html" title=" " alt="" coords="725,80,872,107"/>
<area shape="rect" href="pico_8h.html" title=" " alt="" coords="840,304,901,331"/>
<area shape="rect" href="rp2__common_2hardware__timer_2include_2hardware_2timer_8h.html" title=" " alt="" coords="281,229,415,256"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2types_8h_source.html" title=" " alt="" coords="700,528,801,555"/>
<area shape="rect" title=" " alt="" coords="599,379,713,405"/>
<area shape="rect" href="common_2pico__base__headers_2include_2pico_2config_8h_source.html" title=" " alt="" coords="819,379,923,405"/>
<area shape="rect" href="platform_8h.html" title=" " alt="" coords="1283,379,1405,405"/>
<area shape="rect" href="error_8h_source.html" title=" " alt="" coords="481,379,575,405"/>
<area shape="rect" href="assert_8h_source.html" title=" " alt="" coords="485,603,590,629"/>
<area shape="rect" title=" " alt="" coords="603,677,685,704"/>
<area shape="rect" title=" " alt="" coords="789,603,859,629"/>
<area shape="rect" title=" " alt="" coords="639,603,713,629"/>
<area shape="rect" title=" " alt="" coords="789,453,953,480"/>
<area shape="rect" href="compiler_8h_source.html" title=" " alt="" coords="1152,453,1333,480"/>
<area shape="rect" href="sections_8h_source.html" title=" " alt="" coords="1357,453,1536,480"/>
<area shape="rect" href="panic_8h_source.html" title=" " alt="" coords="1560,453,1720,480"/>
<area shape="rect" title=" " alt="" coords="1744,453,1955,480"/>
<area shape="rect" title=" " alt="" coords="977,453,1127,480"/>
<area shape="rect" title=" " alt="" coords="1147,528,1338,555"/>
<area shape="rect" title=" " alt="" coords="5,304,187,331"/>
<area shape="rect" title=" " alt="" coords="211,304,381,331"/>
<area shape="rect" title=" " alt="" coords="640,304,816,331"/>
<area shape="rect" title=" " alt="" coords="456,304,616,331"/>
<area shape="rect" href="rp2350_2hardware__structs_2include_2hardware_2structs_2sha256_8h_source.html" title=" " alt="" coords="844,155,1039,181"/>
<area shape="rect" href="address__mapped_8h.html" title=" " alt="" coords="836,229,1047,256"/>
<area shape="rect" title=" " alt="" coords="1071,229,1249,256"/>
</map>
</div>
</div>
<p><a href="rp2__common_2pico__sha256_2include_2pico_2sha256_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structpico__sha256__state.html">pico_sha256_state</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA-256 state used by the API.  <a href="structpico__sha256__state.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gadb68f9eb89ce1a5b795463cd083a30a0"><td class="memItemLeft" align="right" valign="top">
typedef struct <a class="el" href="structpico__sha256__state.html">pico_sha256_state</a>&#160;</td><td class="memItemRight" valign="bottom"><b>pico_sha256_state_t</b></td></tr>
<tr class="memdesc:gadb68f9eb89ce1a5b795463cd083a30a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA-256 state used by the API. <br /></td></tr>
<tr class="separator:gadb68f9eb89ce1a5b795463cd083a30a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga56a125e51ec616f61082cc63c8599dcb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga56a125e51ec616f61082cc63c8599dcb">pico_sha256_try_start</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a> endianness, bool use_dma)</td></tr>
<tr class="memdesc:ga56a125e51ec616f61082cc63c8599dcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a SHA-256 calculation returning immediately with an error if the SHA-256 hardware is not available.  <a href="group__pico__sha256.html#ga56a125e51ec616f61082cc63c8599dcb">More...</a><br /></td></tr>
<tr class="separator:ga56a125e51ec616f61082cc63c8599dcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e6d3e0a3cb87e32a73757bcda88ebc1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga6e6d3e0a3cb87e32a73757bcda88ebc1">pico_sha256_start_blocking_until</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a> endianness, bool use_dma, <a class="el" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> until)</td></tr>
<tr class="memdesc:ga6e6d3e0a3cb87e32a73757bcda88ebc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a SHA-256 calculation waiting for a defined period for the SHA-256 hardware to be available.  <a href="group__pico__sha256.html#ga6e6d3e0a3cb87e32a73757bcda88ebc1">More...</a><br /></td></tr>
<tr class="separator:ga6e6d3e0a3cb87e32a73757bcda88ebc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf8fdc6d7438ffed9fcbc124eb134ae6e"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#gaf8fdc6d7438ffed9fcbc124eb134ae6e">pico_sha256_start_blocking</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, enum <a class="el" href="group__hardware__sha256.html#gaaf3089af3667088256de5d352973d5e6">sha256_endianness</a> endianness, bool use_dma)</td></tr>
<tr class="memdesc:gaf8fdc6d7438ffed9fcbc124eb134ae6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start a SHA-256 calculation, blocking forever waiting until the SHA-256 hardware is available.  <a href="group__pico__sha256.html#gaf8fdc6d7438ffed9fcbc124eb134ae6e">More...</a><br /></td></tr>
<tr class="separator:gaf8fdc6d7438ffed9fcbc124eb134ae6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga43c112e22aea468ce0551c5078e155cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga43c112e22aea468ce0551c5078e155cd">pico_sha256_update</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, const uint8_t *data, size_t data_size_bytes)</td></tr>
<tr class="memdesc:ga43c112e22aea468ce0551c5078e155cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add byte data to be SHA-256 calculation.  <a href="group__pico__sha256.html#ga43c112e22aea468ce0551c5078e155cd">More...</a><br /></td></tr>
<tr class="separator:ga43c112e22aea468ce0551c5078e155cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9bf8472019386229c3ba3b6d169b9656"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga9bf8472019386229c3ba3b6d169b9656">pico_sha256_update_blocking</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, const uint8_t *data, size_t data_size_bytes)</td></tr>
<tr class="memdesc:ga9bf8472019386229c3ba3b6d169b9656"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add byte data to be SHA-256 calculation.  <a href="group__pico__sha256.html#ga9bf8472019386229c3ba3b6d169b9656">More...</a><br /></td></tr>
<tr class="separator:ga9bf8472019386229c3ba3b6d169b9656"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4eac54bf699dba0067a22ae3ef5ae121"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pico__sha256.html#ga4eac54bf699dba0067a22ae3ef5ae121">pico_sha256_finish</a> (<a class="el" href="group__pico__sha256.html#gadb68f9eb89ce1a5b795463cd083a30a0">pico_sha256_state_t</a> *state, <a class="el" href="unionsha256__result__t.html">sha256_result_t</a> *out)</td></tr>
<tr class="memdesc:ga4eac54bf699dba0067a22ae3ef5ae121"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish the SHA-256 calculation and return the result.  <a href="group__pico__sha256.html#ga4eac54bf699dba0067a22ae3ef5ae121">More...</a><br /></td></tr>
<tr class="separator:ga4eac54bf699dba0067a22ae3ef5ae121"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>
